New Resource : `azurerm_api_management_workspace_logger` #30652

sinbai · 2025-09-19T03:46:34Z

Community Note

Please vote on this PR by adding a 👍 reaction to the original PR to help the community and maintainers prioritize for review
Please do not leave comments along the lines of "+1", "me too" or "any updates", they generate extra noise for PR followers and do not help prioritize for review

Description

Swigger: https://github.com/Azure/azure-rest-api-specs/blob/a61456ebadb3ad73cee898b8bdd2f14885663332/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2024-05-01/apimworkspaceloggers.json#L208

PR Checklist

I have followed the guidelines in our Contributing Documentation.
I have checked to ensure there aren't other open Pull Requests for the same update/change.
I have checked if my changes close any open issues. If so please include appropriate closing keywords below.
I have updated/added Documentation as required written in a helpful and kind way to assist users that may be unfamiliar with the resource / data source.
I have used a meaningful PR title to help maintainers and other users understand this change and help prevent duplicate work.
For example: “resource_name_here - description of change e.g. adding property new_property_name_here”

Changes to existing Resource / Data Source

I have added an explanation of what my changes do and why I'd like you to include them (This may be covered by linking to an issue above, but may benefit from additional explanation).
I have written new tests for my resource or datasource changes & updated any relevant documentation.
I have successfully run tests with my changes locally. If not, please provide details on testing challenges that prevented you running the tests.
(For changes that include a state migration only). I have manually tested the migration path between relevant versions of the provider.

Testing

My submission includes Test coverage as described in the Contribution Guide and the tests pass. (if this is not possible for any reason, please include details of why you did or could not add test coverage)

Change Log

Below please provide what should go into the changelog (if anything) conforming to the Changelog Format documented here.

New Resource : azurerm_api_management_workspace_logger [Support for API Management Workspaces feature set #30522]

This is a (please select all that apply):

Bug Fix
New Feature (ie adding a service, resource, or data source)
Enhancement
Breaking Change

Related Issue(s)

Fixes #30522

ms-zhenhua

Hi @sinbai ,

Thanks for this PR - I've taken a look through and left some comments inline. If we can fix those up, this should be good to go 👍

ms-zhenhua · 2025-09-28T06:38:55Z

website/docs/r/api_management_workspace_logger.html.markdown

+
+* `description` - (Optional) Specifies a description of the API Management Workspace Logger.
+
+* `resource_id` - (Optional) Specifies the target resource ID of the API Management Workspace Logger, which can be either an azure event hub or an application insights resource.


Suggested change

* `resource_id` - (Optional) Specifies the target resource ID of the API Management Workspace Logger, which can be either an azure event hub or an application insights resource.

* `resource_id` - (Optional) Specifies the target resource ID of the API Management Workspace Logger, which can be either an Azure Event Hub or an application insights resource.

ms-zhenhua · 2025-09-28T06:39:18Z

website/docs/r/api_management_workspace_logger.html.markdown

+
+An `eventhub` block supports the following:
+
+* `name` - (Required) Specifies the name of the eventhub.


Suggested change

* `name` - (Required) Specifies the name of the eventhub.

* `name` - (Required) Specifies the name of the Event Hub.

ms-zhenhua · 2025-09-28T06:39:32Z

website/docs/r/api_management_workspace_logger.html.markdown

+
+* `name` - (Required) Specifies the name of the eventhub.
+
+* `connection_string` - (Optional) Specifies the connection string of the eventhub namespace.


Suggested change

* `connection_string` - (Optional) Specifies the connection string of the eventhub namespace.

* `connection_string` - (Optional) Specifies the connection string of the Event Hub namespace.

ms-zhenhua · 2025-09-28T06:39:38Z

website/docs/r/api_management_workspace_logger.html.markdown

+
+* `connection_string` - (Optional) Specifies the connection string of the eventhub namespace.
+
+* `endpoint_uri` - (Optional) Specifies the endpoint address of an eventhub namespace.


Suggested change

* `endpoint_uri` - (Optional) Specifies the endpoint address of an eventhub namespace.

* `endpoint_uri` - (Optional) Specifies the endpoint address of an Event Hub namespace.

ms-zhenhua · 2025-09-28T06:39:49Z

website/docs/r/api_management_workspace_logger.html.markdown

+
+-> **Note:** Exactly one of `connection_string` or `endpoint_uri` must be specified.
+
+* `user_assigned_identity_client_id` - (Optional) Specifies the client ID of user-assigned identity that has the "Azure Event Hubs Data Sender" role on the target eventhub namespace.


Suggested change

* `user_assigned_identity_client_id` - (Optional) Specifies the client ID of user-assigned identity that has the "Azure Event Hubs Data Sender" role on the target eventhub namespace.

* `user_assigned_identity_client_id` - (Optional) Specifies the client ID of user-assigned identity that has the "Azure Event Hubs Data Sender" role on the target Event Hub namespace.

internal/services/apimanagement/api_management_workspace_logger_resource.go

ms-zhenhua · 2025-09-28T06:52:51Z

internal/services/apimanagement/api_management_workspace_logger_resource.go

+
+type ApiManagementWorkspaceLoggerResource struct{}
+
+var _ sdk.Resource = ApiManagementWorkspaceLoggerResource{}


Suggested change

var _ sdk.Resource = ApiManagementWorkspaceLoggerResource{}

var _ sdk.ResourceWithUpdate = ApiManagementWorkspaceLoggerResource{}

ms-zhenhua · 2025-09-28T07:13:33Z

internal/services/apimanagement/api_management_workspace_logger_resource.go

+					credentials["identityClientId"] = eventHub.UserAssignedIdentityClientId
+				}
+
+				if metadata.ResourceData.HasChange("eventhub.0.name") {


why not use metadata.ResourceData.HasChange("eventhub") and put them in a single expand function?

ms-zhenhua · 2025-09-28T07:28:57Z

internal/services/apimanagement/api_management_workspace_logger_resource.go

+	output := EventHubModel{
+		Name: (*input.Credentials)["name"],
+	}
+
+	if endpoint, ok := (*input.Credentials)["endpointAddress"]; ok {
+		output.EndpointUri = endpoint
+	}


could you use if condition to confirm whether name and endpointAddress exist before assigning the value?

ms-zhenhua · 2025-09-28T07:44:27Z

internal/services/apimanagement/api_management_workspace_logger_resource.go

+		output.EndpointUri = endpoint
+	}
+
+	if eventhub := expandApiManagementWorkspaceLoggerEventHub(model.EventHub); eventhub != nil {


it looks weird to use an expand function in a flatten function. Could you directly use value from model.EventHub?

sinbai · 2025-09-29T10:11:42Z

Hi @sinbai ,

Thanks for this PR - I've taken a look through and left some comments inline. If we can fix those up, this should be good to go 👍

Hi @ms-zhenhua thanks for your feedback. I've addressed the comments, and test results included below. Could you kindly review it again?

ziyeqf · 2025-10-06T04:20:59Z

internal/services/apimanagement/api_management_workspace_logger_resource.go

+							"eventhub.0.user_assigned_identity_client_id",
+						},
+						ValidateFunc: validation.StringIsNotEmpty,
+					},


nit, adding a new line may looks better

ziyeqf · 2025-10-06T04:45:11Z

mostly LGTM but one small comment

sinbai · 2025-10-09T03:31:32Z

mostly LGTM but one small comment

Hi @ziyeqf thanks for your feedback. I've fixed the comments, could you please take another look?

ms-zhenhua · 2025-10-13T02:46:07Z

website/docs/r/api_management_workspace_logger.html.markdown

+
+* `application_insights` - (Optional) Specifies the application insights of the API Management Workspace Logger. Changing this forces a new resource to be created.
+
+* `eventhub` - (Optional) Specifies the eventhub of the API Management Workspace Logger. Changing this forces a new resource to be created.


eventhub should be put after description

Hi @ms-zhenhua , I've fixed the comment, could you please take another look?

ziyeqf · 2025-10-13T03:03:15Z

LGTM now please address Zhenhua's comment.

ms-zhenhua

LGTM~

…m into apim/new_resource_workspace_logger

mbfrahry

Hey @sinbai, thanks for opening this PR. We normally try to split out a single resource that has different types/kinds into their own resources to make it more maintainable and make it easier on the user to interact with it.

mbfrahry · 2025-10-16T21:34:25Z

internal/services/apimanagement/api_management_workspace_logger_resource.go

+			}
+
+			if len(model.ApplicationInsights) > 0 {
+				parameters.Properties.LoggerType = logger.LoggerTypeApplicationInsights


It looks like there are 3 LoogerTypes at the moment. Managing all those in a single resource is not ideal and they should be split into their own resources

github-actions bot added documentation dependencies service/api-management size/XL waiting-response labels Sep 19, 2025

sinbai force-pushed the apim/new_resource_workspace_logger branch from be7401f to ba3ea75 Compare September 19, 2025 05:34

github-actions bot added waiting-response and removed waiting-response labels Sep 19, 2025

sinbai force-pushed the apim/new_resource_workspace_logger branch from ba3ea75 to 340d310 Compare September 19, 2025 05:56

github-actions bot added waiting-response and removed waiting-response labels Sep 19, 2025

sinbai force-pushed the apim/new_resource_workspace_logger branch from 340d310 to 85a9606 Compare September 19, 2025 06:48

github-actions bot added waiting-response and removed waiting-response labels Sep 19, 2025

sinbai force-pushed the apim/new_resource_workspace_logger branch from 85a9606 to 09731b2 Compare September 23, 2025 06:48

github-actions bot added waiting-response and removed waiting-response labels Sep 23, 2025

sinbai force-pushed the apim/new_resource_workspace_logger branch from 09731b2 to 9ae0273 Compare September 23, 2025 07:37

github-actions bot added waiting-response and removed waiting-response labels Sep 23, 2025

sinbai force-pushed the apim/new_resource_workspace_logger branch from 9ae0273 to 59d7898 Compare September 23, 2025 07:49

github-actions bot added waiting-response and removed waiting-response labels Sep 23, 2025

sinbai force-pushed the apim/new_resource_workspace_logger branch from 59d7898 to 65fbc33 Compare September 23, 2025 09:39

github-actions bot removed the waiting-response label Sep 23, 2025

sinbai force-pushed the apim/new_resource_workspace_logger branch from 65fbc33 to d05c2f2 Compare September 24, 2025 08:42

ms-zhenhua suggested changes Sep 28, 2025

View reviewed changes

github-actions bot assigned ms-zhenhua Sep 28, 2025

github-actions bot added waiting-response and removed waiting-response labels Sep 28, 2025

sinbai force-pushed the apim/new_resource_workspace_logger branch from e638215 to 33b5f36 Compare September 29, 2025 09:02

rcskosir added the new-resource label Sep 29, 2025

ziyeqf reviewed Oct 6, 2025

View reviewed changes

github-actions bot added the waiting-response label Oct 6, 2025

github-actions bot removed the waiting-response label Oct 9, 2025

ms-zhenhua suggested changes Oct 13, 2025

View reviewed changes

github-actions bot added the waiting-response label Oct 13, 2025

sinbai added 4 commits October 13, 2025 13:17

new resource azurerm_api_management_workspace_logger

6431fe4

fix comments

aff3306

fix comments

8222b20

fix comment

1cfec52

sinbai force-pushed the apim/new_resource_workspace_logger branch from ca15edd to 1cfec52 Compare October 13, 2025 05:22

github-actions bot removed the waiting-response label Oct 13, 2025

ms-zhenhua approved these changes Oct 13, 2025

View reviewed changes

sinbai marked this pull request as ready for review October 13, 2025 06:29

sinbai requested review from a team, WodansSon and magodo as code owners October 13, 2025 06:29

mybayern1974 unassigned ms-zhenhua Oct 13, 2025

Merge branch 'main' of github.com:hashicorp/terraform-provider-azurer…

e404c9f

…m into apim/new_resource_workspace_logger

mbfrahry requested changes Oct 16, 2025

View reviewed changes

github-actions bot assigned mbfrahry Oct 16, 2025

github-actions bot added the waiting-response label Oct 16, 2025


		* `description` - (Optional) Specifies a description of the API Management Workspace Logger.

		* `resource_id` - (Optional) Specifies the target resource ID of the API Management Workspace Logger, which can be either an azure event hub or an application insights resource.


		An `eventhub` block supports the following:

		* `name` - (Required) Specifies the name of the eventhub.


		* `name` - (Required) Specifies the name of the eventhub.

		* `connection_string` - (Optional) Specifies the connection string of the eventhub namespace.


		* `connection_string` - (Optional) Specifies the connection string of the eventhub namespace.

		* `endpoint_uri` - (Optional) Specifies the endpoint address of an eventhub namespace.


		-> Note: Exactly one of `connection_string` or `endpoint_uri` must be specified.

		* `user_assigned_identity_client_id` - (Optional) Specifies the client ID of user-assigned identity that has the "Azure Event Hubs Data Sender" role on the target eventhub namespace.


		type ApiManagementWorkspaceLoggerResource struct{}

		var _ sdk.Resource = ApiManagementWorkspaceLoggerResource{}

	var _ sdk.Resource = ApiManagementWorkspaceLoggerResource{}
	var _ sdk.ResourceWithUpdate = ApiManagementWorkspaceLoggerResource{}


		* `application_insights` - (Optional) Specifies the application insights of the API Management Workspace Logger. Changing this forces a new resource to be created.

		* `eventhub` - (Optional) Specifies the eventhub of the API Management Workspace Logger. Changing this forces a new resource to be created.

New Resource : azurerm_api_management_workspace_logger #30652

Are you sure you want to change the base?

New Resource : azurerm_api_management_workspace_logger #30652

Uh oh!

Conversation

sinbai commented Sep 19, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Community Note

Description

PR Checklist

Changes to existing Resource / Data Source

Testing

Change Log

Related Issue(s)

Uh oh!

ms-zhenhua left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

sinbai commented Sep 29, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

ziyeqf commented Oct 6, 2025

Uh oh!

sinbai commented Oct 9, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

ziyeqf commented Oct 13, 2025

Uh oh!

ms-zhenhua left a comment

Choose a reason for hiding this comment

Uh oh!

mbfrahry left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

New Resource : `azurerm_api_management_workspace_logger` #30652

New Resource : `azurerm_api_management_workspace_logger` #30652

sinbai commented Sep 19, 2025 •

edited

Loading